From b6a61425562fc9ffcb4a0a9a19d2e85184dfcd1e Mon Sep 17 00:00:00 2001 From: =?utf8?q?Tadej=20Borov=C5=A1ak?= Date: Fri, 5 Mar 2010 23:33:29 +0100 Subject: [PATCH] [docs] Move documentation to inline comments: GtkAction MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611952 Signed-off-by: Javier Jardón --- docs/reference/gtk/tmpl/gtkaction.sgml | 560 ------------------------- gtk/gtkaction.c | 39 ++ 2 files changed, 39 insertions(+), 560 deletions(-) delete mode 100644 docs/reference/gtk/tmpl/gtkaction.sgml diff --git a/docs/reference/gtk/tmpl/gtkaction.sgml b/docs/reference/gtk/tmpl/gtkaction.sgml deleted file mode 100644 index f35a111f60..0000000000 --- a/docs/reference/gtk/tmpl/gtkaction.sgml +++ /dev/null @@ -1,560 +0,0 @@ - -GtkAction - - -An action which can be triggered by a menu or toolbar item - - - -Actions represent operations that the user can be perform, along with -some information how it should be presented in the interface. Each action -provides methods to create icons, menu items and toolbar items representing -itself. - - -As well as the callback that is called when the action gets activated, the -following also gets associated with the action: - - a name (not translated, for path lookup) - a label (translated, for display) - an accelerator - whether label indicates a stock id - a tooltip (optional, translated) - a toolbar label (optional, shorter than label) - -The action will also have some state information: - - visible (shown/hidden) - sensitive (enabled/disabled) - - - -Apart from regular actions, there are toggle -actions, which can be toggled between two states and radio actions, of which only one in a group -can be in the "active" state. Other actions can be implemented as #GtkAction -subclasses. - - -Each action can have one or more proxy menu item, toolbar button or -other proxy widgets. Proxies mirror the state of the action (text -label, tooltip, icon, visible, sensitive, etc), and should change when -the action's state changes. When the proxy is activated, it should -activate its action. - - - - -#GtkActionGroup, #GtkUIManager - - - - - - - -The GtkAction struct contains only private members -and should not be accessed directly. - - - - - - - - -@action: the object which received the signal. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@name: -@label: -@tooltip: -@stock_id: -@Returns: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@sensitive: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@visible: - - - - - - - -@action: - - - - - - - -@action: -@icon_size: -@Returns: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@proxy: - - - - - - - -@action: -@proxy: - - - - - - - -@action: -@Returns: - - - - - - - -@action: - - - - - - - -@action: - - - - - - - -@action: - - - - - - - -@action: - - - - - - - -@action: -@proxy: - - - - - - - -@action: -@proxy: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@always_show: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@accel_path: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@accel_group: - - - - - - - -@action: -@label: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@short_label: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@tooltip: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@stock_id: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@icon: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@icon_name: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@visible_horizontal: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@visible_vertical: - - - - - - - -@action: -@Returns: - - - - - - - -@action: -@is_important: - - - - - - - -@action: -@Returns: - - diff --git a/gtk/gtkaction.c b/gtk/gtkaction.c index 6c552cc4ae..1cb1cecaae 100644 --- a/gtk/gtkaction.c +++ b/gtk/gtkaction.c @@ -28,6 +28,45 @@ * GTK+ at ftp://ftp.gtk.org/pub/gtk/. */ +/** + * SECTION:gtkaction + * @Short_description: An action which can be triggered by a menu or toolbar item + * @Title: GtkAction + * @See_also: #GtkActionGroup, #GtkUIManager + * + * Actions represent operations that the user can be perform, along with + * some information how it should be presented in the interface. Each action + * provides methods to create icons, menu items and toolbar items + * representing itself. + * + * As well as the callback that is called when the action gets activated, + * the following also gets associated with the action: + * + * a name (not translated, for path lookup) + * a label (translated, for display) + * an accelerator + * whether label indicates a stock id + * a tooltip (optional, translated) + * a toolbar label (optional, shorter than label) + * + * The action will also have some state information: + * + * visible (shown/hidden) + * sensitive (enabled/disabled) + * + * Apart from regular actions, there are toggle + * actions, which can be toggled between two states and radio actions, of which only one in a group + * can be in the "active" state. Other actions can be implemented as #GtkAction + * subclasses. + * + * Each action can have one or more proxy menu item, toolbar button or + * other proxy widgets. Proxies mirror the state of the action (text + * label, tooltip, icon, visible, sensitive, etc), and should change when + * the action's state changes. When the proxy is activated, it should + * activate its action. + */ + #include "config.h" #include "gtkaction.h" -- 2.30.2